﻿using System;

namespace jQueryLib
{
    public class AjaxSettings
    {
        /// <summary>
        /// Default: depends on DataType
        /// The content type sent in the request header that tells the server what kind of response it will accept in return. If the accepts setting needs modification, it is recommended to do so once in the $.ajaxSetup() method.
        /// </summary>
        public object Accepts;

        /// <summary>
        /// Default: true
        /// By default, all requests are sent asynchronously (i.e. this is set to true by default). If you need synchronous requests, set this option to false. Cross-domain requests and dataType: "jsonp" requests do not support synchronous operation. Note that synchronous requests may temporarily lock the browser, disabling any actions while the request is active.        
        /// </summary>
        public bool Async;

        /// <summary>
        /// A pre-request callback function that can be used to modify the jqXHR (in jQuery 1.4.x, XMLHTTPRequest) object before it is sent. Use this to set custom headers, etc. The jqXHR and settings maps are passed as arguments. This is an Ajax Event. Returning false in the beforeSend function will cancel the request.
        /// </summary>
        public Func<bool, JQXmlHttpRequest, AjaxSettings> BeforeSend;

        /// <summary>
        /// Default: true, false for dataType 'script' and 'jsonp'
        /// If set to false, it will force requested pages not to be cached by the browser. Setting cache to false also appends a query string parameter, "_=[TIMESTAMP]", to the URL.
        /// </summary>
        public bool Cache;

        /// <summary>
        /// A function to be called when the request finishes (after success and error callbacks are executed).
        /// <para>String categorizing the status of the request ("success", "notmodified", "error", "timeout", "abort", or "parsererror").</para>
        /// </summary>
        public Action<JQXmlHttpRequest, string> Complete;

        /// <summary>
        /// A map of string/regular-expression pairs that determine how jQuery will parse the response, given its content type.
        /// </summary>
        public object Contents;

        /// <summary>
        /// When sending data to the server, use this content-type. If you explicitly pass in a content-type to $.ajax() then it'll always be sent to the server (even if no data is sent). 
        /// Data will always be transmitted to the server using UTF-8 charset; you must decode this appropriately on the server side.
        /// Default: 'application/x-www-form-urlencoded'
        /// </summary>
        public string ContentType;

        /// <summary>
        /// This object will be made the context of all Ajax-related callbacks. By default, the context is an object that represents the ajax settings used in the call ($.ajaxSettings merged with the settings passed to $.ajax).
        /// </summary>
        public object Context;

        /// <summary>
        /// Default: {"* text": window.String, "text html": true, "text json": jQuery.parseJSON, "text xml": jQuery.parseXML}
        /// A map of dataType-to-dataType converters. Each converter's value is a function that returns the transformed value of the response.
        /// </summary>
        public object Converters;

        /// <summary>
        /// Default: false for same-domain requests, true for cross-domain requests
        /// If you wish to force a crossDomain request (such as JSONP) on the same domain, set the value of crossDomain to true. This allows, for example, server-side redirection to another domain.
        /// </summary>
        public bool CrossDomain;

        /// <summary>
        /// Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests. See processData option to prevent this automatic processing. Object must be Key/Value pairs. If value is an Array, jQuery serializes multiple values with same key based on the value of the traditional setting (described below).
        /// </summary>
        public object Data;

        /// <summary>
        /// A function to be used to handle the raw response data of XMLHttpRequest.This is a pre-filtering function to sanitize the response. You should return the sanitized data. The function accepts two arguments: The raw data returned from the server and the 'dataType' parameter.
        /// object function(data, type)
        /// </summary>
        public Func<object, object, string> DataFilter;

        /// <summary>
        /// Default: Intelligent Guess (xml, json, script, or html)
        /// The type of data that you're expecting back from the server. If none is specified, jQuery will try to infer it based on the MIME type of the response (an XML MIME type will yield XML, in 1.4 JSON will yield a JavaScript object, in 1.4 script will execute the script, and anything else will be returned as a string).
        /// <para>can be above or jsonp, text</para>
        /// </summary>
        public string DataType;

        /// <summary>
        /// A function to be called if the request fails.
        /// function(jqXHR, status, error)
        /// <para>Possible values for the second argument (besides null) are "timeout", "error", "abort", and "parsererror".</para>
        /// <para>When an HTTP error occurs, errorThrown receives the textual portion of the HTTP status, such as "Not Found" or "Internal Server Error."</para>
        /// </summary>
        public Action<JQXmlHttpRequest, string, string> Error;

        /// <summary>
        /// Whether to trigger global Ajax event handlers for this request. The default is true. Set to false to prevent the global handlers like ajaxStart or ajaxStop from being triggered.
        /// </summary>
        public bool Global;

        /// <summary>
        /// A map of additional header key/value pairs to send along with the request.
        /// This setting is set before the beforeSend function is called; therefore, any values in the headers setting can be overwritten from within the beforeSend function.
        /// </summary>
        public object Headers;

        /// <summary>
        /// Allow the request to be successful only if the response has changed since the last request. This is done by checking the Last-Modified header. Default value is false, ignoring the header.
        /// </summary>
        public bool IfModified;

        /// <summary>
        /// Allow the current environment to be recognized as "local," (e.g. the filesystem), even if jQuery does not recognize it as such by default.
        /// The following protocols are currently recognized as local: file, *-extension, and widget. If the isLocal setting needs modification, it is recommended to do so once in the $.ajaxSetup() method.
        /// </summary>
        public bool IsLocal;

        /// <summary>
        /// Override the callback function name in a jsonp request. This value will be used instead of 'callback' in the 'callback=?' part of the query string in the url.
        /// So {jsonp:'onJSONPLoad'} would result in 'onJSONPLoad=?' passed to the server.
        /// </summary>
        public string Jsonp;

        /// <summary>
        /// Specify the callback function name for a JSONP request. This value will be used instead of the random name automatically generated by jQuery.
        /// It is preferable to let jQuery generate a unique name as it'll make it easier to manage the requests and provide callbacks and error handling. You may want to specify the callback when you want to enable better browser caching of GET requests.
        /// </summary>
        public string JsonpCallback;

        /// <summary>
        /// A mime type to override the XHR mime type.
        /// </summary>
        public string MimeType;

        /// <summary>
        /// A password to be used in response to an HTTP access authentication request.
        /// </summary>
        public string Password;

        /// <summary>
        /// By default, data passed in to the data option as an object (technically, anything other than a string) will be processed and transformed into a query string, fitting to the default content-type "application/x-www-form-urlencoded".
        /// If you want to send a DOMDocument, or other non-processed data, set this option to false.
        /// </summary>
        public bool ProcessData;

        /// <summary>
        /// Only for requests with "jsonp" or "script" dataType and "GET" type. Forces the request to be interpreted as a certain charset.
        /// Only needed for charset differences between the remote and local content.
        /// </summary>
        public string ScriptCharset;

        /// <summary>
        /// A map of numeric HTTP codes and functions to be called when the response has the corresponding code.
        /// </summary>
        public object StatusCode;

        /// <summary>
        /// A function to be called if the request succeeds.
        /// function(data, status, jqXHR)
        /// </summary>
        public Action<object, string, JQXmlHttpRequest> Success;

        /// <summary>
        /// Set a timeout (in milliseconds) for the request.
        /// This will override any global timeout set with $.ajaxSetup().
        /// The timeout period starts at the point the $.ajax call is made;
        /// if several other requests are in progress and the browser has no connections available, it is possible for a request to time out before it can be sent.
        /// </summary>
        public long Timeout;

        /// <summary>
        /// Set this to true if you wish to use the traditional style of param serialization.
        /// </summary>
        public bool Traditional;

        /// <summary>
        /// The type of request to make ("POST" or "GET"), default is "GET".
        /// Note: Other HTTP request methods, such as PUT and DELETE, can also be used here, but they are not supported by all browsers.
        /// </summary>
        public string Type;

        /// <summary>
        /// Default: The current page
        /// A string containing the URL to which the request is sent.
        /// </summary>
        public string Url;

        /// <summary>
        /// A username to be used in response to an HTTP access authentication request.
        /// </summary>
        public string Username;

        /// <summary>
        /// Default: ActiveXObject when available (IE), the XMLHttpRequest otherwise
        /// Callback for creating the XMLHttpRequest object.
        /// Defaults to the ActiveXObject when available (IE), the XMLHttpRequest otherwise.
        /// Override to provide your own implementation for XMLHttpRequest or enhancements to the factory.
        /// </summary>
        public Func<JQXmlHttpRequest> Xhr;

        /// <summary>
        /// A map of fieldName-fieldValue pairs to set on the native XHR object.
        /// </summary>
        public object XhrFields;
    }
}
